NmlsCompany Json Schema

NmlsCompany

active : boolean

address : Address

censustract : string

Property ID in the national census data.

city : string

City where the property is located.

country : string

Country where the property is located.

county : string

County where the property is located.

This is used for countyFips. The best practice is to pass to alleviate issues when the same zip/state spans > 1 county (counties may have different loan limits).

Must pass state fips + county fips. Example, 25017 for Middlesex County, MA; 36103 for Suffolk, NY.

countyFips : string

CountyFips ID.

Populate this field if you are concerned that the state and zip area spans more than one county, in which case the API will only return the first county in the list.

countyName : string

Name of the county the property is located in.

defaultZipFipsComboOnMismatch : boolean

latitude : number

Property latitude.

longitude : number

Property longitude.

msa : string

province : string

The province where the property is located.

state : string

The state where the property is located.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

stateFips : string

This field is DEFUNCT.

DO NOT USE.

street : string

The first line of the property street address.

Example: 10 Rose Court

streetCont : string

The second line of the property street address.

Example: Apt. C

zip : string

The property zip code.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

zipExt : string

The four digit zip code area extension. The dash is not necessary.

Example: 2435

Do not enter in this format: -2435

allowPublicReview : boolean

apiSecret : string

armRoundedFullyIndexedRate : boolean

authenticationURL : string

autoExpireLoan : boolean

autoSync : boolean

batchPricingCallbackURL : string

blacklisted : boolean

blendIntegration : BlendIntegration

active : boolean

armFixedTermOptions : Array[AnswerOption]

displayText : string

value : string

closestToPar : boolean

closestToTargetValue : number

closestToTargetValueFrom : number

closestToTargetValueTo : number

companyId : string

companyName : string

customQuestions : Array[Question]

answerDataType : string

answerOptions : Array[AnswerOption]

controlType : string

customQuestionId : string

defaultAnswerValue : string

displayText : string

grouping : string

hiddenInUserInterface : boolean

id : ObjectId

counter : integer

internal only

date : string

The current date.

internal only

machineIdentifier : integer

internal only

processIdentifier : integer

internal only

time : integer

internal only

timeSecond : integer

internal only

timestamp : integer

internal only

intMaxValue : integer

intMinValue : integer

integrationFieldPath : string

loanPurposes : Array[string]

maxSelections : integer

mergePriority : integer

minSelections : integer

order : integer

path : string

placeholder : string

questionType : string

readOnly : boolean

required : boolean

showCondition : QuestionShowCondition

comparison : string

customQuestionId : string

integrationFieldPath : string

value : string

values : Array[string]

stringMaxLength : integer

stringMinLength : integer

unusedByAdapter : boolean

userType : string

defaultAmortizationType : Array[string]

defaultArmFixedTerms : Array[string]

defaultDayLock : object

defaultLoanTerms : Array[string]

defaultMortgageTypes : Array[string]

lenderpriceApiKey : string

maxCompensation : number

minimumCompensation : number

originationFeeFromAdjustment : boolean

purchaseAffordabilityProducts : Array[string]

showDisqualify : boolean

showDisqualifyRules : boolean

tenantId : string

tenantName : string

useDefaultEstimatedMi : boolean

useDisplayName : boolean

userId : string

blendIntegrations : Array[BlendIntegration]

active : boolean

armFixedTermOptions : Array[AnswerOption]

closestToPar : boolean

closestToTargetValue : number

closestToTargetValueFrom : number

closestToTargetValueTo : number

companyId : string

companyName : string

customQuestions : Array[Question]

defaultAmortizationType : Array[string]

defaultArmFixedTerms : Array[string]

defaultDayLock : object

defaultLoanTerms : Array[string]

defaultMortgageTypes : Array[string]

lenderpriceApiKey : string

maxCompensation : number

minimumCompensation : number

originationFeeFromAdjustment : boolean

purchaseAffordabilityProducts : Array[string]

showDisqualify : boolean

showDisqualifyRules : boolean

tenantId : string

tenantName : string

useDefaultEstimatedMi : boolean

useDisplayName : boolean

userId : string

broker : boolean

companyFeatures : CompanyFeatures

creationDate : string

features : Array[Feature]

creationDate : string

description : string

id : ObjectId

modifiedByOverride : string

name : string

roles : Array[string]

id : ObjectId

modifiedByOverride : string

computeCompPlanWithTotalLoanAmt : boolean

contactDetails : ContactDetails

contactPerson : ContactPerson

creationDate : string

customFields : object

customFiles : object

dataWriteURL : string

defaultDisclaimerId : ObjectId

defaultTurnTimes : Array[TurnTime]

defaultUserPictureLink : string

demo : boolean

ein : string

ernstPassword : string

ernstUserName : string

expandedEligibilityHWURL : string

expandedEligibilityURL : string

externalLogo : string

feeAPIURL : string

feeAPIURLAlternate : string

feeAPIURLBatch : string

footerPhrase : string

govtFeeAccess : GovtFeeAccess

annualMiPremium : boolean

fundingFee : boolean

guaranteeFee : boolean

ufmipFee : boolean

handleLock : boolean

headerPhrase : string

id : ObjectId

includeExtendedRatesInLenderFilter : boolean

jsonCustomFields : Array[JsField]

key : string

value : string

jsonCustomFiles : Array[JsCompanyFieldFile]

jsonSystemAdminFields : Array[JsField]

ldapAPIURL : string

lender : boolean

linkSmoToDynamicFields : boolean

loadLoanAPIURL : string

mailingAddress : Address

marketPlace : boolean

marketPlaceNewUrl : string

modifiedByOverride : string

name : string

nmlsId : string

otherContacts : Array[ContactPerson]

partnerData : PartnerData

passwordExpirationDays : integer

priceExceptionFormURL : string

priceExceptionURL : string

pricingConfiguration : PricingConfiguration

computationService : string

id : ObjectId

rateLimiterByFeature : object

pricingProjection : Array[string]

qmTreshold : Number

rateSheetGeneratorConfig : CompanyRateSheetGeneratorConfig

autoGenerateRateSheets : boolean

notificationEmails : Array[string]

rateSheetFilename : string

rateSheetGenerationType : string

separateByGroupId : boolean

sftpDirectories : Array[string]

sftpDirectory : string

sftpHostname : string

sftpPassword : string

sftpSalt : string

sftpUsername : string

urlDomainDownload : string

zipFilename : string

zipFiles : boolean

ratingSummary : RatingSummary

scoreMap : object

totalReviewScore : integer

totalReviews : integer

redirectAtLogin : boolean

shortName : string

ssoIdentifier : string

tags : Array[string]

userGroupMortgageMarketPlace : string

website : string

writebackURL : string

Name	Description	Data Type
active		boolean
address		Address
allowPublicReview		boolean
apiSecret		string
armRoundedFullyIndexedRate		boolean
authenticationURL		string
autoExpireLoan		boolean
autoSync		boolean
batchPricingCallbackURL		string
blacklisted		boolean
blendIntegration		BlendIntegration
blendIntegrations		Array[BlendIntegration]
broker		boolean
companyFeatures		CompanyFeatures
computeCompPlanWithTotalLoanAmt		boolean
contactDetails		ContactDetails
contactPerson		ContactPerson
creationDate		string
customFields		object
customFiles		object
dataWriteURL		string
defaultDisclaimerId		ObjectId
defaultTurnTimes		Array[TurnTime]
defaultUserPictureLink		string
demo		boolean
ein		string
ernstPassword		string
ernstUserName		string
expandedEligibilityHWURL		string
expandedEligibilityURL		string
externalLogo		string
feeAPIURL		string
feeAPIURLAlternate		string
feeAPIURLBatch		string
footerPhrase		string
govtFeeAccess		GovtFeeAccess
handleLock		boolean
headerPhrase		string
id		ObjectId
includeExtendedRatesInLenderFilter		boolean
jsonCustomFields		Array[JsField]
jsonCustomFiles		Array[JsCompanyFieldFile]
jsonSystemAdminFields		Array[JsField]
ldapAPIURL		string
lender		boolean
linkSmoToDynamicFields		boolean
loadLoanAPIURL		string
mailingAddress		Address
marketPlace		boolean
marketPlaceNewUrl		string
modifiedByOverride		string
name		string
nmlsId		string
otherContacts		Array[ContactPerson]
partnerData		PartnerData
passwordExpirationDays		integer
priceExceptionFormURL		string
priceExceptionURL		string
pricingConfiguration		PricingConfiguration
pricingProjection		Array[string]
qmTreshold		Number
rateSheetGeneratorConfig		CompanyRateSheetGeneratorConfig
ratingSummary		RatingSummary
redirectAtLogin		boolean
shortName		string
ssoIdentifier		string
tags		Array[string]
userGroupMortgageMarketPlace		string
website		string
writebackURL		string

Lender Price API Web Service